home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 001a / szmod144.zip / SZMODEM.DOC < prev    next >
Text File  |  1991-06-12  |  42KB  |  877 lines

  1. SZMODEM ver 1.43
  2. -----------------
  3. By Scott M. Baker
  4.  
  5.  
  6. What is SZModem?
  7.  
  8.          SZModem is a zmodem-compatible protocol with a few added features. It
  9.    is fully compatible with normal zmodem, but adds special capabilities both
  10.    when talking to normal zmodems and while talking to other copies of
  11.    SZModem.
  12.          The main idea behind SZModem is that you should be able to do other
  13.    things while the transfer is taking place. Rather than have your computer
  14.    tied up for an hour downloading a file, you can move around in the SDOS
  15.    window and do directory maintenance, etc...
  16.  
  17. What will it do?
  18.  
  19.          While SZModem is transferring a file, you may do the following:
  20.  
  21.       Connected to a "normal" zmodem such as DSZ.
  22.  
  23.           - List files marked for upload
  24.           - List files received as they are received
  25.           - Uses SDOS (simulated dos) to view directories, copy files,
  26.             etc while the transfer is taking place.
  27.           - View file contents as the file is being received (good for
  28.             text files)
  29.           - Play single-player games while transferring.
  30.           - Built in mail reader allows sysops who are using a BBS program
  31.             that uses FIDO message formats to read mail while transferring.
  32.  
  33.       Connected to another copy of SZModem.
  34.  
  35.           - All of the above capabilities
  36.           - A "chat" mode allows the two sides to talk to each other.
  37.           - Play multiplayer games such as Four-In-A-Row
  38.           - The sender will automatically send a "advance transfer list"
  39.             listing the files to be sent. This way, the receiver knows
  40.             what he is receiving.
  41.           - SZTurbo option allows SZModem to pass flow control characters
  42.             unaltered across the modem. This allows for up to a four percent
  43.             effeciency gain over normal Zmodem.
  44.           - Ability to use large zmodem packet lengths - up to 2048 bytes
  45.             at 2400 baud and 4096 bytes for higher speeds.
  46.           - LZW compression routines allow significant efficiency improvements
  47.             for text files, ASCII data, etc.
  48.  
  49. Command specifics
  50. -----------------
  51.  
  52.    F1 - Transfer (send) list
  53.  
  54.          This command will produce a windowed list of the files that have
  55.      been sent, aborted, marked for sending, etc. Included is the file
  56.      name, size, and all other pertinant information. You may use the up
  57.      and down arrows if necessary to scroll the list.
  58.          Pressing F1 again (i.e. while you are already in TLIST) will toggle
  59.      between the file-information list and the file-description list.
  60.  
  61.    F2 - Received file list
  62.  
  63.          This command will produce a listing of the files are have been
  64.      received. Similar to the "F1" list above, you may use the up/down
  65.      arrows to scroll the list. THe list is updated as files are received.
  66.          If you are connected to another copy of SZModem, the sender
  67.      will transmit a special "advance transfer list" containing a listing
  68.      of the files that will be sent. This list will be displayed with the
  69.      F2 command.
  70.          As with F1 above, pressing F2 again will toggle betweem the file
  71.      information display and the file description display.
  72.  
  73.    F3 - SDOS (simulated dos)
  74.  
  75.          SDOS is a special dos emulator that lets you perform a variety of
  76.      operations while the transfer is taking place. You can copy/move files,
  77.      list directories, change attributes, etc - most of the common things you
  78.      do with normal dos.
  79.          You may get a listing of supported SDOS commands by typing "HELP"
  80.      at the dos prompt. Typing help with a command name (i.e. HELP DIR) will
  81.      display help for that specific command.
  82.          Most SDOS commands are pseudo-multitasked as to not interfere with
  83.      the transfer, although with high speed modems (i.e. 14,400 baud and
  84.      up) the transfer may slow down during disk-intensive operations.
  85.  
  86.    F4 - COMM PARAMS
  87.  
  88.          This command will pop up a display of the current communications
  89.      parameters - baud rate, parity, buffer status, etc. It can be useful in
  90.      debugging difficulties.
  91.  
  92.    F5 - VIEW
  93.  
  94.          Pressing F5 will allow you to "view" the transfer as it is taking
  95.      place. You will actually see the characters of the file, zmodem
  96.      handshaking, and line noise as it takes place.
  97.          If you press F5 while you are already in the view window, you will
  98.      toggle the view mode. There are 6 different modes. Here is a listing:
  99.  
  100.            1 - Direct ascii printing of characters as they are sent or recvd
  101.            2 - Ascii print only RECEIVED characters
  102.            3 - Ascii print only TRANSMITTED characters
  103.            4 - HEX printing of transmitted and received characters
  104.            5 - HEX printing of only received characters
  105.            6 - HEX printing of only transmitted characters
  106.  
  107.          The modes will cycle one at a time each time you press F5. Initially,
  108.      this whole idea of the view mode was simply a debugging option for me,
  109.      but I figure some users might like to watch the transfer taking place.
  110.  
  111.    F6 - MESSAGES
  112.  
  113.          The message display shows a log of the various messages that SZModem
  114.      displays on the screen - CRC Error, Waiting for ZRINIT, stuff like that.
  115.  
  116.    F7 - CHAT
  117.  
  118.          This command can only be used when two SZModems are connected to
  119.      each other - it won't work with a normal Zmodem. The chat mode allows
  120.      you to talk to the user at the other end of the transfer. The screen
  121.      will be split into two windows - one for what you type, one for what
  122.      the other guy types.
  123.          Pressing CTRL-G will page the other user if he isn't at his
  124.      terminal. The page will beep for thirty seconds, one beep every
  125.      three seconds.
  126.  
  127.    F8 - GAMES
  128.  
  129.          The games menu will be displayed and you can select a game to play
  130.      while the transfer is taking place. There are two kinds of games -
  131.      single player games which to play by yourself and multiplayer games
  132.      in which you play against the guy on the other end.
  133.          The single player games may be player no matter what you are
  134.      connected to, but the multiplayer games require you to be connected to
  135.      another copy of SZModem.
  136.  
  137.    F9 - MAIL READER
  138.  
  139.          This is a feature designed to be used by the sysops of Bulletin
  140.      Boards which have a FIDO compatible message format. (See the below
  141.      section on "The Mail Reader" for info on setting up this feature)
  142.          By pressing F9, the sysop will be allowed to read messages in the
  143.      chosen message base. There are several additional UNLISTED keys available
  144.      in this window:
  145.  
  146.          "N"  Move forward one message
  147.          "P"  Move backwards one message
  148.       <Space> If the message is more than one screen, this will scroll the
  149.               window.
  150.  
  151.    F10 - EXIT
  152.  
  153.          This brings you the exit option which aborts all files and returns
  154.      you to the DOS prompt.
  155.  
  156. COMMAND LINE OPTIONS
  157. --------------------
  158.        SZModem was designed specially to have a command line similar to the
  159. popular DSZ Zmodem protocol. This way users with an understanding of DSZ
  160. can easily set up SZModem. The options area as follows:
  161.  
  162. "SZMODEM <options> <transfer type> <filenames>"
  163.  
  164. Options can be any one of the following:
  165.  
  166.    "PORT x"     specifies using comport x. (i.e. "PORT 2" would use com2)
  167.  
  168.    "SPEED x"    specifies the baud rate (i.e. "SPEED 2400 would use 2400 baud)
  169.  
  170.    "IRQ x"      specifies a nonstandard IRQ. (NOTE: please specify the
  171.                 address in DECIMAL, not HEX). You must supply BOTH an IRQ
  172.                 and an address to use nonstandard ports.
  173.  
  174.    "ADDR x"     specifies a nonstandard ADDRESS. (NOTE: please specify
  175.                 the address in decimal, not hex). You must supply BOTH an IRQ
  176.                 and and address to use nonstandard ports.
  177.  
  178.    "/NOLOG"     disables logging to the "SZMODEM.LOG" file.
  179.  
  180.    "/M"         monochrome mode.
  181.  
  182.    "/DORINFO x" Specifies the node number of a dorinfo.def file to grab the
  183.                 user's name from. If you specify this option, SZModem will
  184.                 load in the dorinfo, get the user name, and display it in
  185.                 the screen so you know who is downloading. (I.e. specifying
  186.                 "/DORINFO 1" would load in "DORINFO1.DEF")
  187.  
  188.    "/INSIZE x"  Specifies the size (in bytes) of the internal comm input
  189.                 buffer. (Note: not used if using fossil)
  190.  
  191.    "/OUTSIZE x" Specifies the size (in bytes) of the internal comm output
  192.                 buffer. (Note: Not used if using fossil)
  193.  
  194.    "/SZPATH x"  Specifies a path to which the SZXFER$$.LST and SZMODEM.LOG
  195.                 files will be written to. If not specified, the files will
  196.                 be created in the current directory.
  197.  
  198.  "/DELAYTIME x" SZModem by default will wait 5 seconds at the end of
  199.                 transfer for a keypress to before exiting. BBS sysops may
  200.                 wish to lower this time for faster operation. The "x"
  201.                 specifies the default time to delay, which may be
  202.                 from 0-30 seconds. (NOTE: /DELAYTIME can be abbreviated
  203.                 /DT)
  204.  
  205.    "/SZTURBO"   Causes SZModem to attempt to use the SZTurbo option if
  206.                 possible. If SZTurbo is to operate, both sides must have this
  207.                 option set. See "SZTURBO" below. (NOTE: /SZTURBO can be
  208.                 abbreviated /SZT)
  209.  
  210.    "/NBS"       This stands for "normal block size". By default, if two
  211.                 SZmodem's are connected, they will allow the Zmodem packet
  212.                 length to rise to 2048 bytes/packet at 2400 baud or 4096
  213.                 bytes/packet for higher speeds. Specifying "/NBS" will force
  214.                 SZModem to use block lengths of 1024 bytes or less.
  215.  
  216.    "/NORBL"     Will cause your copy of SZModem to refuse to accept LARGE
  217.                 format (i.e. embedded file description info) advance transfer
  218.                 lists.
  219.  
  220.    "/NOSBL"     Will cause your copy of SZModem to refuse to send LARGE
  221.                 format (i.e. embedded file description info) advance transfer
  222.                 lists.
  223.  
  224.    "/FL"        This will cause SZModem to create an additional log file
  225.                 called "FILELOG.TXT". This log is intended to allow users to
  226.                 keep a record of files they receive. It only logs RECEIVED
  227.                 files and it includes the name, size, and optional description
  228.                 of the file.
  229.  
  230.    "/NOPAGE"    This will prevent another copy of SZModem from paging your
  231.                 copy.
  232.  
  233.   "/FILEDESC x" This specifies an additional FILEDESC list of file
  234.                 descriptions. "x" is the path and filename of the file. See
  235.                 "Large Advance Transfer Lists" for more info.
  236.  
  237.    "/CHECKSNOW" If you are using a CGA card and it gets snow, try using this
  238.                 option.
  239.  
  240.    "/NOCOMP"    This will force SZModem to disable file compression.
  241.  
  242.  "/FIDOAREA x"  Specifies a fido-format message base that SZModem's built
  243.                 in mail reader will allow the sysop to read while a transfer
  244.                 is taking place. The "x" is the path. (i.e. "/FIDOAREA
  245.                 I:\BINKLEY\MESSAGES").
  246.  
  247.    "/EGA"       If you have an EGA or VGA display, this switch will enable the
  248.                 43/50 line modes.
  249.  
  250.    "/DL"        This option will cause SZModem to create a DSZ.LOG file. This
  251.                 file will contain a DSZ-style log. This option may be used
  252.                 with BBS programs that require a DSZ.LOG file to operate their
  253.                 external protocols. SZMODEM also will enable the DSZ.LOG if
  254.                 the environment variable "DSZLOG=xxx" is used.
  255.  
  256.    "/CFGPATH x" Specifies a path to where the configuration file (SZMODEM.CFG)
  257.                 can be found. "x" is the path with or without a trailing
  258.                 backslash. It doesn't matter.
  259.  
  260.    "/HARD"      This turns on HARD flow control. This means that when your
  261.                 modem drops CTS, SZModem will stop transmitting until CTS
  262.                 is raised again. This option is frequently used with high
  263.                 speed modems and/or locked baud rates.
  264.  
  265.    "/SOFT"      This is similar to the above HARD flow control, but uses
  266.                 ascii characters to control the flow. Namely, the Xon and
  267.                 Xoff characters - when XOFF is received, SZModem will stop
  268.                 transmitting and when XON is received, SZModem will resume.
  269.                 (Note: SZTURBO mode is not available with this type of
  270.                 handshaking)
  271.  
  272.    "/LOCK x"    Specifies a locked baud rate. The com port will be set to
  273.                 the baud rate specified by this parameter, and the baud rate
  274.                 specified by "BAUD x" above will be used for estimation
  275.                 purposes.
  276.  
  277. Transfer type may be any one of the following:
  278.  
  279.    "RZ"        receive zmodem file(s)
  280.    "SZ"        send zmodem file(s)
  281.  
  282. Filenames are interpreted as follows:
  283.  
  284.    Send mode:  Multiple filespecs may be present. Wildcards are allowed.
  285.  
  286.    Recv mode:  A path to the receive directory is expected. No filenames
  287.                are necessary. If you add a filename, SZModem will strip it
  288.                from the string and ignore it.
  289.  
  290. EXAMPLES:
  291. ---------
  292.  
  293. "SZMODEM PORT 4 SPEED 9600 SZ \UPLOAD\*.ZIP"
  294.  
  295.        Send all the .ZIP files in you upload directory using COM4 at
  296.   9600 baud.
  297.  
  298.  
  299. "SZMODEM SPEED 1200 RZ"
  300.  
  301.        Receive files at 1200 baud using COM1. Store them in the current
  302.   directory.
  303.  
  304.  
  305. "SZMODEM PORT 3 RZ \TEMP"
  306.  
  307.        Receive files at 2400 baud using COM2. Store them in the "\TEMP"
  308.   directory.
  309.  
  310. Files
  311. -----
  312.        SZMODEM.EXE   -  The executable code for SZModem. This is what is
  313.                         called to initiate a transfer. This version requires
  314.                         approx 160-180k of memory.
  315.  
  316.        SZMODOVR.EXE  -  This is the same as SZMODEM.EXE, but is an overlay
  317.                         version. Portions of the code will be swapped to/from
  318.                         disk to conserve memory. This version requires
  319.                         approx 120-150k of memory.
  320.  
  321.        SZMODSML.EXE  -  This version will save even more over the above
  322.                         version. Certain features have been left out (such
  323.                         as the game module and the mail readter), but if you
  324.                         really are short on memory, give this a try. Requires
  325.                         between 100-120k of ram.
  326.  
  327.        SZCONFIG.EXE  -  This program allows you to set a variety of
  328.                         SZModem's default options and store them in the
  329.                         SZMODEM.CFG file.
  330.  
  331.       *SZMODEM.CFG   -  This file is created by the above SZCONFIG.EXE. It
  332.                         contains default option values for various SZMODEM
  333.                         parameters. Basically, you can use SZCONFIG.EXE to
  334.                         put the options here rather than specifying them on
  335.                         the command line.
  336.  
  337.        SZMODEM.DOC   -  These docs that you are reading.
  338.  
  339.        SZMODEM.TRV   -  A "trivia" file which lets you play trivia during
  340.                         SZModem.
  341.  
  342.        SZMODEM.HLP   -  An ASCII help file which contains help on the SimDos
  343.                         commands.
  344.  
  345.       *SZMODEM.LOG   -  A log created which contains a listing of files
  346.                         transferred, dates/times, etc. May be disabled
  347.                         with the "/NOLOG" option. You may set the
  348.                         path this file will be placed in with the "/SZPATH"
  349.                         option.
  350.  
  351.       *DSZ.LOG       -  If the /DL parameter was specified, this file will
  352.                         be created to allow for compatibility with the
  353.                         popular DSZ protocol.
  354.  
  355.       *SZXFER$$.LST  -  This is the "advance transfer list" file. It is
  356.                         created by the sender and if the receiver is also a
  357.                         zmodem, is sent to so the receiver may have a list
  358.                         of files to be received ahead of time.
  359.  
  360.       *FILELOG.TXT   -  If the "/FL" parameter is specified, this will will
  361.                         contain a listing of all files received (downloaded)
  362.                         by SZModem. Included is the file name, size, and
  363.                         optional description.
  364.  
  365.       (* Denotes file is CREATED by SZModem, not distributed with the package)
  366.  
  367. Hardware Requirements
  368. ---------------------
  369.      Processor: 10mhz 80286 or greater suggested, but will work with any
  370.                 IBM-PC compatible machine.
  371.  
  372.      Display:   Anything should work
  373.  
  374.      Memory:    SZMODEM.EXE  160k-180k
  375.                 SZMODOVR.EXE 120k-150k
  376.                 SZMODSML.EXE 100k-120k
  377.  
  378. Nonstandard port addresses:
  379. ---------------------------
  380.          You must use the "IRQ x" and "ADDR x" parameters to specify a
  381.    nonstandard com port. Numbers must be in DECIMAL, not HEX. DO NOT
  382.    specify a "PORT" if you use nonstandards.
  383.  
  384.    For example:
  385.  
  386.    "SZMODEM IRQ 2 ADDR 1016" would cause szmodem to use whatever port is
  387.                              at IRQ=2 and ADDRESS=1016 ($3F8 hex)
  388.  
  389. The Overlay Version
  390. -------------------
  391.          Two versions of SZMODEM are distributed - SZMODEM.EXE and
  392.    SZMODOVR.EXE. Both versions have the same features, but SZMODOVR will swap
  393.    its code to/from disk to conserve memory space. This swapping allows
  394.    SZMODOVR to use between 20-30k less memory than SZMODEM.EXE.
  395.          There is only one problem. Swapping code requires time. So, if you
  396.    perform many SimDos commands and other options, disk usage may be
  397.    increased, slowing down the transfer. The best choice is to use SZMODEM.EXE
  398.    if it will fit into memory and SZMODOVR.EXE if it will not.
  399.  
  400. Flow Control, Handshaking, High-Speed Modems, Locked baud
  401. ---------------------------------------------------------
  402.          SZModem includes two command line options for controlling computer-
  403.    to-modem handshaking. This handshaking allows the modem to send some form
  404.    of signal to SZModem to tell SZModem to stop sending data if the modem's
  405.    buffer becomes overflowed.
  406.          If you are using a 2400 baud modem or lower, and are sending data to
  407.    this modem at 2400 baud, then no handshaking options should be necessary.
  408.    But, if you are using a high speed modem at a locked baud rate, handshaking
  409.    is VERY necessary.
  410.          The are two type of handshaking: HARD and SOFT. Hard handshaking uses
  411.    the CTS/RTS lines (i.e. wires) between your modem to control data flow and
  412.    is considered the better of the two. SOFT handshaking uses two special
  413.    ASCII characters, XON and XOFF, to control handshaking. Basically, you have
  414.    to match SZModem to the type of handshaking your modem uses.
  415.          To enable HARD handshaking, specify the "/HARD" option on the command
  416.    line. To enable SOFT handshaking, specify "/SOFT". You should only specify
  417.    one, not both.
  418.          Consult your modem manual, bbs software docs, etc for more
  419.    information on handshaking.
  420.  
  421. SZTurbo
  422. -------
  423.          SZTurbo is an option that will allow you to improve file transfer
  424.    efficiency by as much as four percent. To explain how SZTurbo works,
  425.    I must discuss a little about how Zmodem itself works.
  426.          In the Zmodem specification, certain bytes cannot be transmitted
  427.    freely across the modem connection. These bytes are XON, XOFF, ZDLE (a byte
  428.    very important to Zmodem), and a few others. If for example, an XOFF
  429.    was transmitted across the modem link, it could cause difficulties.
  430.          Although these bytes may not be transmitted, they do occur in binary
  431.    files so Zmodem must find someway to transmit them. What it does is send
  432.    a ZDLE followed by byte (i.e. the XOFF) XOR 64. This translates the illegal
  433.    character to a harmless ASCII letter that may be freely sent across the
  434.    modem link.
  435.          A few quick thoughts and you should be able to see that every time
  436.    one of these "illegal" characters are encountered, two bytes (The ZDLE
  437.    and the character XOR 64) must be sent. Sending two characters instead of one
  438.    obviously adds overhead to the transfer, slowing it down.
  439.          It turns out that most of these "illegal" characters are not illegal
  440.    under most situations. Almost all current moedems are able to transfer
  441.    XONs,XOFFs, etc just fine. So basically what SZTURBO does is send these
  442.    illegal characters just like any other character. Here's a quick diagram
  443.    to help explain this:
  444.  
  445.                                      Characters sent        Character(s) sent
  446.        Character in File             without SZTurbo          with SZTurbo
  447.        -----------------          ---------------------     ----------------
  448.          ZCHAT (#14)                ZDLE (#24) "N"            ZDLE (#24) "N"
  449.          DLE   (#16)                ZDLE (#24) "P"            DLE  (#16)
  450.          XON   (#17)                ZDLE (#24) "Q"            XON  (#17)
  451.          XOFF  (#19)                ZDLE (#24) "S"            XOFF (#19)
  452.          ZDLE  (#24)                ZDLE (#24) "X"            ZDLE (#24) "X"
  453.  
  454.          As you can see, SZTurbo shortens the sequences for DLE, XON, and
  455.    XOFF from 2 characters down to one character. While this does not seem like
  456.    much, it can add up to a four percent efficiency gain. When you're paying
  457.    the long distance bill, you'll appreciate this.
  458.          Specifying "/SZTURBO" on the command line will cause your copy of
  459.    SZModem to "attempt" to engage the SZTurbo option. SZTurbo is only
  460.    available if both sides have the option specified.
  461.  
  462. Large Advance Transfer Lists
  463. ----------------------------
  464.          Starting with this version, there is support for a "large" advance
  465.    transfer list. The main difference between the normal list and the "large"
  466.    list is that the large list contains optional file descriptions as well
  467.    as the name, date, etc. The receiver or sender may browse through these
  468.    descriptions while the transfer is taking place.
  469.          The problem is, SZModem can't just make up these descriptions
  470.    itself. The sender must somehow provide SZModem with the descriptions. If
  471.    the sender is a bbs program, then the descriptions are available from
  472.    the BBS's file catalog. The descriptions must, however, still be converted
  473.    to a format that SZModem can understand.
  474.          SZModem will look for file descriptions in the file "FILEDESC.TXT"
  475.    (or "FILEDE1.TXT", "FILEDE2.TXT", etc if you are multinode) in the
  476.    directory specified by the /SZPATH option. This file follows a simple
  477.    format. It is plain ASCII with each line of the file corresponding to a
  478.    file. The filename starts at column 1 and the descriptions starts at
  479.    column 15. For example:
  480.  
  481.  
  482. ::-- Col. 1  ::--- col. 15
  483. ::           ::
  484. \/           \/
  485. SZMOD120.ZIP  Zmodem protocol with Chat, Simdos, etc
  486. GALWAR75.ZIP  Galactic Warzone version 7.5
  487. DOORDR30.ZIP  Doordriver door support routines
  488. MACH10.ZIP    Mach-10 bbs
  489.  
  490.  
  491.          When SZModem loads, providing the /NOSBL switch is not specified and
  492.    providing this file exists, the descriptions will be searched, loaded, and
  493.    sent to the receiver providing his /NORBL switch is not set.
  494.          As you have probably noticed, this format is probably not what your
  495.    bbs uses. Since I don't have information on the file formats of most BBS
  496.    packages, I had to make do with this "generic" format. Hopefully, some
  497.    bbs sysops who are programmers can write a utility to grab the necessary
  498.    descriptions out of their file catalogs and throw them into the
  499.    FILEDESC.TXT file.
  500.          Note: The FILEDESC.TXT file may be named FILEDE1.TXT or FILEDE2.TXT
  501.    depending on your configuration. The /DORINFO switch will determine which
  502.    .TXT file SZModem will look for. If no /DORINFO is specified, FILEDESC.TXT
  503.    will be used. If /DORINFO 1 was specified, FILEDE1.TXT will be loaded.
  504.          Examples:
  505.  
  506.                                                         Filedesc file used
  507.                                                         ------------------
  508.          SZMODEM SZ FOO.BAR                             FILEDESC.TXT
  509.          SZMODEM /DORINFO 1 SZ FOO.BAR                  FILEDE1.TXT
  510.          SZMODEM /DORINFO 2 SZ FOO.BAR                  FILEDE2.TXT
  511.          SZMODEM /SZPATH \protocol SZ FOO.BAR           \PROTOCOL\FILEDESC.TXT
  512.          SZMODEM /SZPATH \protocol /DORINFO 1 .....     \PROTOCOL\FILEDE1.TXT
  513.  
  514.          Now, a quick word on the /NOSBL and /NORBL switches. If you specify
  515.    /NOSBL, your copy of SZModem will not send the description info under any
  516.    circumstances. If you specify /NORBL, your SZModem will not allow another
  517.    SZModem to send the description info under any circumstances. Example:
  518.  
  519.  
  520.          Sender               Receiver                  Desc info sent
  521.          ------------------   -------------------       --------------
  522.          SZMODEM SZ ...       SZMODEM RZ ...                *YES
  523.          SZMODEM /NOSBL SZ    SZMODEM (anything)             NO
  524.          SZMODEM (anything)   SZMODEM /NORBL                 NO
  525.  
  526.          (* only if FILEDESC.TXT, FILEDE1.TXT, etc exists on sender side)
  527.  
  528.          Additional FILEDESC files may be specified using the /FILEDESC
  529.    option. Use the format "/FILEDESC x" where "x" is the path and filename
  530.    of the additional list to search. You may add as many of these additional
  531.    lists as you wish. (NOTE: Operation will occur faster if all of the
  532.    descriptions are in one file rather than many file)
  533.  
  534. File Lists
  535. ----------
  536.          If you specify @<filename> on then command line, <filename> will be
  537.    opened and any file paths contained within will be sent. For example,
  538.    suppose a textfile, "TOSEND.TXT" contained the following:
  539.  
  540.  
  541.    \DOWNLOAD\SZMOD120.ZIP
  542.    \MACH10\WELCOME.TXT
  543.    \GALWAR\TWARS.EXE
  544.  
  545.          If you called up SZModem with the command line "SZMODEM SZ
  546.    @TOSEND.TXT", SZModem would then send the three files listed above. This
  547.    allows you to specify many different filenames in an ascii file rather
  548.    than have to fit them all on the command line.
  549.          You may also specify SZModem parameters in these "file lists". You
  550.    could specify "/DORINFO 1 /SZTURBO /SZPATH \protocols", etc and then call
  551.    it up with the "@" sign rather than having to put all of those options on
  552.    the command line.
  553.  
  554. File Compression
  555. ----------------
  556.          SZModem now includes a LZW compression module which can compress
  557.    the file data as it is being sent. Although for binary and compressed data,
  558.    the LZW compression will make little difference, it can create substantial
  559.    compression for ASCII data, text files, word-processor files, etc.
  560.          By default, compression is automatically enabled for any file
  561.    with an extention other than ZIP,ZOO,PAK,ARC. If both SZModems support file
  562.    compression and there is memory for the 21k hashing table, compression
  563.    will occur on a block-by-block basis. The "packet size" display will
  564.    reflect the size of compressed data subpacket and the (real) size of the
  565.    uncompressed data in paranthesis (i.e. "Packet size....: 1398 (2048)" would
  566.    indicate that 2048 bytes were compressed into 1398 bytes).
  567.          To use the compression algorythm, an extra 21k of data space is
  568.    necessary for a special "hashing table". If there is not 21k of memory
  569.    available for SZModem, the hashing table will not be created, and
  570.    compression will be disabled.
  571.          The command line switch "/NOCOMP" may be used to force compression
  572.    to be disabled.
  573.  
  574. The Mail Reader
  575. ---------------
  576.          SZModem is equipped with a mail reader capable which allows the
  577.    sysop to read any messages in a fido-format message base. This feature is
  578.    only useful for BBS systems or mail point systems, and has no particular
  579.    interest to users.
  580.          So far, SZModem can only handle one message area. I am making
  581.    provisions to add support for more area, but that will be in a later
  582.    version.
  583.          To enable the mail reader, add the "/FIDOAREA x" switch into the
  584.    command line, with "x" being the path to your fido area. (i.e. "/FIDOAREA
  585.    I:\BINKLEY\MESSAGE"). No trailing backslash is necessary.
  586.          Then, you may use the F9 key to enter the mail reader. The "N"
  587.    and "P" keys will move you forward or reverse in the area and the SPACE
  588.    bar will scroll a message.
  589.  
  590.  
  591. Benchmarks
  592. ----------
  593.          The following chart compares the CPS readings for some various
  594.    protocols. SZMODEM ver 1.31 was used for the SZMODEM tests and DSZ1612
  595.    was used for the DSZ Zmodem, Xmodem, and ymodem tests.
  596.          The tests were performed between two AT-class machines running
  597.    at 8mhz.
  598.  
  599.                           SZMODEM    SZMODEM  DSZ     DSZ     DSZ
  600. Filename      File Size   w/SZTURBO           ZMODEM  XMODEM  YMODEM
  601. ------------  ---------   ---------  -------  ------  ------  ------
  602. SYSOP.DOC       18357        399       390      235     200    200
  603. MACHCTL.ZIP     20643        236       232      234     201    200
  604. MOUSE.COM       14249        284       274      234     202    199
  605. SIMCGA.ZIP       2406        233       233      235     200    200
  606.  
  607.  
  608.  
  609. Revison History
  610. ---------------
  611.        Version 1.00  -  First public BETA release.
  612.  
  613.                         This software has not been tested very well at
  614.                         this point. There may be trouble with high speed
  615.                         modems, COM3/4 conflicts, etc. Please report any
  616.                         bugs to my bbs listed below.
  617.  
  618.        Version 1.01  -  Fixed a problem that caused the DORINFO display
  619.                         that caused the users last name and city to be
  620.                         displayed. Now, the user's full name and city is
  621.                         displayed.
  622.  
  623.        Version 1.02  -  Added the "/SZPATH" option to allow the user
  624.                         to specify what directory the SZMODEM.LOG and
  625.                         SZXFER$$.LST files will be placed in.
  626.  
  627.                         Fixed a bug which was causing runtime error
  628.                         2 that had to do with the SZXFER$$ list.
  629.  
  630.                         Added "/DELAYTIME" option to specify time that
  631.                         SZModem will delay after a transmission is completed,
  632.                         waiting for a keypress.
  633.  
  634.                         The CHAT indicator will now blink when a remote user
  635.                         is typing in chat and the local user is in another
  636.                         window.
  637.  
  638.        Version 1.10  -  Added FREE and SIZE commands to simdos. See the
  639.                         SZMODEM.HLP file for more information.
  640.  
  641.                         Various cosmetic improvements.
  642.  
  643.                         Made the SIMDOS parser a bit more intelligent. It can
  644.                         now process commands without spaces between parameters
  645.                         such as "DIR/W" or "CD..".
  646.  
  647.                         Added DELNUL command to delete zero-length files.
  648.  
  649.                         SZModem now displays a small message if the user does
  650.                         not specify SZ or RZ. This helps new users to know
  651.                         they do in fact need to specify SZ/RZ.
  652.  
  653.                         SZModem /HELP command now available. Displays a small
  654.                         help screen of some of SZModem's command line
  655.                         parameters.
  656.  
  657.                         Major revisions to the actual ZMODEM transfer code.
  658.  
  659.                         CRC32 now used rather than CRC16 and the block check
  660.                         display now correctly reflects this. (Note: If the
  661.                         sender requests CRC16, the receiver will be stuck with
  662.                         CRC16 also)
  663.  
  664.                         Error correction will now function properly in both
  665.                         CRC32 and CRC16 modes.
  666.  
  667.                         "Last frame" display on receiver now functions
  668.                         properly.
  669.  
  670.                         Default delay time changed from 10 seconds to 5
  671.                         seconds. (See /DELAYTIME above)
  672.  
  673.                         Added an overlay version of the program (SZMODOVR.EXE)
  674.                         to allow for systems with less available memory.
  675.  
  676.        Version 1.20     Added SZTurbo option to increase transfer efficiency
  677.                         by as much as 4%. See the SZTurbo section of this doc
  678.                         for more info.
  679.  
  680.                         Added "/NBS" option to allow users to restrict
  681.                         SZModem's block size down to the standard 1024 bytes/
  682.                         block like normal zmodem.
  683.  
  684.                         The minor version identifier (i.e. .20) is now sent
  685.                         along with the major version identified (i.e. 1)
  686.  
  687.                         Message screen (F6) code revised to reduce flickering
  688.                         and add smoother scrolling.
  689.  
  690.                         Two ZChallenges are now sent between copies of SZModem
  691.                         to allow for additional information to be passed -
  692.                         version numbers, flags, etc.
  693.  
  694.                         Added provisions for LARGE Advance transfer lists.
  695.                         (See Above). The new large list allows the sender to
  696.                         send file descriptions along with the usual file info.
  697.  
  698.                         Fixed the TLIST and RLIST displays so they scroll the
  699.                         corrent number of lines.
  700.  
  701.                         Added "/FL" switch for a received file log.
  702.  
  703.        Version 1.21     Added more information to the log display.
  704.  
  705.                         Fixed a bug which caused file descriptions to be
  706.                         garbage when receiving file from a normal Zmodem.
  707.  
  708.                         Added ability to process file lists. (See above:
  709.                         File lists)
  710.  
  711.                         Added /FILEDESC option to specify additional
  712.                         filedesc files.
  713.  
  714.                         Added the /CHECKSNOW option to enable snow checking.
  715.  
  716.                         Fixed the DELNUL command in SDOS so that it does not
  717.                         try to delete files as they are being received.
  718.  
  719.                         Control-Break is now trapped and no longer aborts the
  720.                         program.
  721.  
  722.                         Added CTRL-G option to allow users to page in chat
  723.                         mode.
  724.  
  725.        Version 1.30     Default internal output buffer size has been
  726.                         changed from 256 bytes to 512 bytes.
  727.  
  728.                         Revised overlay code so hopefully SZMODOVR.EXE can
  729.                         be used by multiple nodes on a network without
  730.                         difficulty.
  731.  
  732.                         Added file compression capability. LZW compression
  733.                         routines will speed up the transmission of most
  734.                         non-compressed data.
  735.  
  736.                         Default internal input/output buffer sizes
  737.                         re-adjusted to 1k and 6k respectively.
  738.  
  739.                         Added a simple sysop mail reader to allow the sysop
  740.                         to read mail while transfer is in progress.
  741.  
  742.                         Fixed a bug with the ZChallenges that caused SZModem
  743.                         to not abort if the Zchallenges were not responded
  744.                         to.
  745.  
  746.                         Included a "Small" version which is even smaller than
  747.                         the overlay version. Left out are the games module
  748.                         and the mail reader module. The filename is
  749.                         SZMODSML.EXE.
  750.  
  751.                         Added a zip viewer to SimDos. The command "ZIPVIEW
  752.                         <filename>" will display the file directory of a
  753.                         zip file.
  754.  
  755.        Version 1.31     Added DEBUG command to simdos to allow users to
  756.                         browse through files in a hexadecimal mode.
  757.  
  758.                         EGA/VGA 43/50 line modes are available with the
  759.                         /EGA command line switch.
  760.  
  761.                         If SZTURBO is enabled and soft (Xon/Xoff) flow
  762.                         control is enabled, the SZTURBO will automatically
  763.                         be disabled.
  764.  
  765.                         Added SZCONFIG.EXE configuration utility.
  766.  
  767.                         /DL command line will enable a DSZ.LOG file log
  768.                         for compatibility with various bbs programs.
  769.  
  770.        Version 1.40     REMOVED FOSSIL SUPPORT
  771.                         There was just too little demand for use of the fossil
  772.                         interface routines and considering the overhead it was
  773.                         adding (an additional jump and compare for every
  774.                         async function can add up), the code was removed and
  775.                         the INTERNAL routines are now accessed directly.
  776.  
  777.                         Major serial code revisions. On locked baud modems,
  778.                         the keyboard I/O shouldn't slow down quite as bad
  779.                         as before. Chat may still appear choppy though.
  780.  
  781.                         Added a DORINFOx.DEF path to SZCONFIG.EXE. You may
  782.                         now set the path that SZModem will look for
  783.                         DORINFOx.DEF with SZCONFIG.EXE.
  784.  
  785.                         Added CFGPATH parameter to specify path to
  786.                         the SZMODEM.CFG file.
  787.  
  788.        Version 1.41     Added information on HandShaking to docs.
  789.  
  790.                         Added handshaking options to SZCONFIG.EXE.
  791.  
  792.                         Added locked baud capabilities with the "/LOCK"
  793.                         parameter.
  794.  
  795.        Version 1.42     Fixed minor bug with command line options. Command
  796.                         line options now override environment vars at all
  797.                         times (i.e. SZMODEM port 2 would override SET DSZPORT=
  798.                         1)
  799.  
  800.                         If transfer times out, szmodem will return errorlevel
  801.                         of 1.
  802.  
  803.                         DSZLOG is now appended to rather than rewritten
  804.                         by SZMODEM.
  805.  
  806.                         Fixed problem with /CFGPATH causing files to be
  807.                         written to the root directory.
  808.  
  809.        Version 1.43     Added abbreviations "/SZT" for /SZTURBO and "/DT" for
  810.                         delay time.
  811.  
  812.                         Added the "BROWSE" command to simdos. Browse will let
  813.                         you scroll up and down within a file.
  814.  
  815.                         Fixed problem with received file path.
  816.  
  817.                         Altered some code in the Z_challenge routine to
  818.                         compensate for a bug in QMODEM (Qmodem does not
  819.                         understand Z_Challenge requests which caused
  820.                         szmodem to abort the xfer)
  821.  
  822.                         Altered some code to hopefully fix a glitch or
  823.                         two at high speeds. (14,400 and 19,200 baud may
  824.                         have gotten some aborts due to "header is fubar"
  825.                         messages. This should now be fixed)
  826.  
  827.        Version 1.44     Some cosmetic improvements and minor bug fixes.
  828.  
  829.                         Added registration request.
  830.  
  831.                         Added support for nonstandard IRQ/address
  832.  
  833.  
  834.  
  835.  
  836.  
  837. Credit to Other Authors
  838. -----------------------
  839.  
  840.        1) Turbo Pascal Zmodem Source. This software was built up from a rather
  841.           buggy source code of Zmodem in turbo pascal. The code did not list
  842.           an author.
  843.  
  844.        2) ASYNC11 package by Mark Shultz. This excellent package provides
  845.           for portions of SZModem's async support. The fossil interface is
  846.           written by myself, but I also integrated these ASYNC11 internal
  847.           routines to provide support for users without fossils.
  848.  
  849. Registration
  850. ------------
  851.        SZModem represents many hours of programming and debugging. If you find
  852. this software useful, then please register your copy to support my efforts. I
  853. can not continue to work on major projects like this without sufficient
  854. compensation.
  855.        The requested registration fee is $25. That will get you a disk
  856. containing the latest version of SZMODEM and place you on my mailing list for
  857. notification of upcoming releases. Included will be a utility which will
  858. allow you to register your copy of szmodem as well as any copies which you
  859. may receive in the future. Both disk formats (3.5" and 5.25" will be included)
  860.        To register, please mail in the included REGISTER.FRM to the following
  861. address along with you check. (Sorry, but I cannot except credit cards)
  862.  
  863.                         Scott Baker
  864.                         6431 Tierra Catalina #48
  865.                         Tucson, AZ 85718
  866.  
  867.        I may also be reached through my online bulletin board:
  868.  
  869.                         The Not-Yet-Named BBS
  870.                         300,1200, 2400 baud
  871.                         (602) 577-3650 <Node 1>
  872.                         (602) 577-3419 <Node 2>
  873.                         Tucson, AZ
  874.  
  875.        The BBS always has the latest copy of SZModem (and any of my other
  876. projects) available for downloads. We are also part of FidoNet and RBBSNET
  877. and offer several file nad message areas.